RHIDP-7560 - Install and configure plugins from Extensions page #1281
Conversation
|
Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1281/ @ 08/11/25 09:05:43 |
modules/dynamic-plugins/proc-extensions-enabling-plugins-installation.adoc
Outdated
Show resolved
Hide resolved
modules/dynamic-plugins/proc-extensions-enabling-plugins-installation.adoc
Outdated
Show resolved
Hide resolved
|
|
||
| // .Procedure | ||
| // . Navigate to RBAC. | ||
| // . Click *Create*. |
There was a problem hiding this comment.
If users have RBAC UI enabled, they can add extensions permissions by creating a role or updating an existing role. My demo video shows how users can do it. You can add screenshots for ref.
without RBAC UI, they would need to configure the csv file in the permissions configuration in the app-config
rbac:
policies-csv-file: <path-to>/rbac-policy.csv
There was a problem hiding this comment.
@debsmita1 I've included instructions for using RBAC UI for extensions permissions. Could you review please?
Also for clarity, can plugins be modified by ANY user by using Extensions in a Dev environment without either having RBAC installed or without the necessary permissions?
modules/dynamic-plugins/proc-extensions-installing-plugins.adoc
Outdated
Show resolved
Hide resolved
…llation.adoc Co-authored-by: Dominika Zemanovicova <[email protected]>
Co-authored-by: Dominika Zemanovicova <[email protected]>
@dzemanov AFAIU the plugin itself is still named |
…ng for administrators
…ng for administrators
…ng for administrators
…ng for administrators
…ng for administrators
…ng for administrators
…ng for administrators
Yes, I can in review show you which places can be renamed. I am just waiting for confirmation we want to do that. It still will be a little confusing, since the plugin name contains |
| [id="proc-extensions-enabling-plugins-installation_{context}"] | ||
| = Configuring {product-very-short} to install plugins by using Extensions | ||
|
|
||
| When you install a plugin using Extensions UI, the configuration that you use is saved to a `dynamic-plugins.marketplace.yaml` file within the `dynamic-plugins-root` persistent volume. This ensures the configuration is available when you restart the application, allowing you to edit or re-enable the plugin. |
There was a problem hiding this comment.
| When you install a plugin using Extensions UI, the configuration that you use is saved to a `dynamic-plugins.marketplace.yaml` file within the `dynamic-plugins-root` persistent volume. This ensures the configuration is available when you restart the application, allowing you to edit or re-enable the plugin. | |
| When you install a plugin using Extensions UI, the configuration that you use is saved to a `dynamic-plugins.extensions.yaml` file within the `dynamic-plugins-root` persistent volume. This ensures the configuration is available when you restart the application, allowing you to edit or re-enable the plugin. |
| apiVersion: rhdh.redhat.com/v1alpha3 | ||
| kind: Backstage | ||
| metadata: | ||
| name: developer-hub | ||
| namespace: rhdh | ||
| spec: | ||
| application: | ||
| dynamicPluginsConfigMapName: dynamic-plugins-rhdh | ||
| extraEnvs: | ||
| envs: | ||
| - name: NODE_ENV | ||
| value: "development" | ||
| secrets: | ||
| - name: secrets-rhdh | ||
| extraFiles: | ||
| mountPath: /opt/app-root/src | ||
| route: | ||
| enabled: true | ||
| database: | ||
| enableLocalDb: true |
There was a problem hiding this comment.
Please fix the indentation here, some places use only 1 space
| global: | ||
| auth: | ||
| backend: | ||
| enabled: true | ||
| clusterRouterBase: apps.<clusterName>.com | ||
| dynamic: | ||
| includes: | ||
| - dynamic-plugins.default.yaml | ||
| - /dynamic-plugins-root/dynamic-plugins.extensions.yaml | ||
| upstream: | ||
| backstage: | ||
| extraEnvVars: | ||
| - name: NODE_ENV | ||
| value: development |
There was a problem hiding this comment.
Please fix the indentation here, some places use only 1 space
|
|
||
| == Creating a role in the {product-short} UI to manage Extensions | ||
|
|
||
| .Prequisites |
There was a problem hiding this comment.
| .Prequisites | |
| .Prerequisites |
|
|
||
| You must create a persistent volume claim (PVC) to ensure that the cache persists when you restart the {product-very-short} application. For more information about using the dynamic plugins cache, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/configuring_red_hat_developer_hub/index#using-the-dynamic-plugins-cache_running-behind-a-proxy[Using the dynamic plugins cache]. | ||
|
|
||
| .Prequisites |
There was a problem hiding this comment.
| .Prequisites | |
| .Prerequisites |
| = Installing plugins by using Extensions | ||
| You can install and configure plugins by using Extensions. | ||
|
|
||
| .Prequisites |
There was a problem hiding this comment.
| .Prequisites | |
| .Prerequisites |
| - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-marketplace | ||
| disabled: false | ||
| pluginConfig: | ||
| dynamicPlugins: | ||
| frontend: | ||
| red-hat-developer-hub.backstage-plugin-marketplace: | ||
| appIcons: | ||
| - name: marketplace | ||
| importName: MarketplaceIcon | ||
| dynamicRoutes: | ||
| - path: /extensions/catalog | ||
| importName: DynamicMarketplacePluginRouter | ||
| mountPoints: | ||
| - mountPoint: application/provider | ||
| importName: InstallationContextProvider | ||
| - mountPoint: internal.plugins/tab | ||
| importName: DynamicMarketplacePluginContent | ||
| config: | ||
| path: marketplace | ||
| title: Catalog |
There was a problem hiding this comment.
Please fix the indentation here, should be 2 spaces.
IMPORTANT: Do Not Merge - To be merged by Docs Team Only
Version(s):
main, 1.7
Issue:
RHIDP-7560
Preview:
Managing plugins by using Extensions